/* ===========================================================
 * TradeManager : An application to trade strategies for the Java(tm) platform
 * ===========================================================
 *
 * (C) Copyright 2011-2011, by Simon Allen and Contributors.
 *
 * Project Info:  org.trade
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
 * USA.
 *
 * [Java is a trademark or registered trademark of Oracle, Inc.
 * in the United States and other countries.]
 *
 * (C) Copyright 2011-2011, by Simon Allen and Contributors.
 *
 * Original Author:  Simon Allen;
 * Contributor(s):   -;
 *
 * Changes
 * -------
 *
 */
package org.trade.core.conversion;

/**
 * This object is responsible for attaching a format mask to an object to be
 * converted e.g. a Date with String in the format YYMM.
 * 
 * @author Simon Allen
 */
public class JavaFormatForObject {
	//
	// Private Attributes
	//
	private String m_format = "";

	private Object m_forObject = null;

	//
	// Public Methods
	//
	/**
	 * Constructor
	 * 
	 * 
	 * 
	 * @param format
	 *            String
	 * @param forObject
	 *            Object
	 */
	public JavaFormatForObject(String format, Object forObject) {
		m_format = format;
		m_forObject = forObject;
	}

	/**
	 * 
	 * @return The format mask for the object.
	 */
	public String getFormat() {
		return (m_format);
	}

	/**
	 * 
	 * @return The object that the format object is for.
	 */
	public Object getForObject() {
		return (m_forObject);
	}

	/**
	 * Method toString.
	 * 
	 * @return String
	 */
	public String toString() {
		if (null == getForObject()) {
			return null;
		} else {
			return getForObject().toString();
		}
	}
}
